/**
 * Copyright (C) 2007-2010 Carnegie Mellon University and others.
 *
 * This file is part of Plural.
 *
 * Plural is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Plural is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Plural; if not, see <http://www.gnu.org/licenses>.
 *
 * Linking Plural statically or dynamically with other modules is
 * making a combined work based on Plural. Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * In addition, as a special exception, the copyright holders of Plural
 * give you permission to combine Plural with free software programs or
 * libraries that are released under the GNU LGPL and with code
 * included in the standard release of Eclipse under the Eclipse Public
 * License (or modified versions of such code, with unchanged license).
 * You may copy and distribute such a system following the terms of the
 * GNU GPL for Plural and the licenses of the other code concerned.
 *
 * Note that people who make modified versions of Plural are not
 * obligated to grant this special exception for their modified
 * versions; it is their choice whether to do so. The GNU General
 * Public License gives permission to release a modified version
 * without this exception; this exception also makes it possible to
 * release a modified version which carries forward this exception.
 */
package edu.cmu.cs.plural.test;

import edu.cmu.cs.crystal.annotations.PassingTest;
import edu.cmu.cs.crystal.annotations.UseAnalyses;
import edu.cmu.cs.plural.annot.Capture;
import edu.cmu.cs.plural.annot.ClassStates;
import edu.cmu.cs.plural.annot.Perm;
import edu.cmu.cs.plural.annot.PluralAnalysis;
import edu.cmu.cs.plural.annot.State;
import edu.cmu.cs.plural.annot.States;
import edu.cmu.cs.plural.annot.Unique;
import edu.cmu.cs.plural.annot.Use;

/**
 * This test checks to make sure that we can use @Capture on a 
 * type that will end up as a field for another class.
 * @author nbeckman
 * @since Jan 20, 2010
 *
 */
@PassingTest
@UseAnalyses(PluralAnalysis.PLURAL)
@States({"init"})
@ClassStates({@State(name="init",inv="unique(getsCaptured) in Open")})
public final class CaptureField {
	private GetsCaptured getsCaptured;
	
	@Unique(requires="init", ensures="init", use=Use.FIELDS)
	public void makeCapturerDoIt() {
		Capturer c = this.getsCaptured.createNewCapturer();
		c.doIt();
	}
}

@States({"Open"})
class GetsCaptured {
	
	@Capture(param="underlying")
	@Perm(requires = "unique(this, Open)", ensures = "unique(result)")
	public Capturer createNewCapturer() {
		return new Capturer();
	}
	
}

class Capturer {
	
	@Perm(ensures="unique(this!fr)")
	public Capturer(){}
	
	@Unique
	void doIt() {}
	
}
